package com.auntvt.timo.jpax.core.service;

import org.springframework.data.domain.Example;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;

import java.util.List;
import java.util.Optional;

/**
 * 对应JpaRepository接口的方法
 *
 * @author 小懒虫 <auntvt@163.com>
 * @date 2021/5/26
 */
public interface JpaService<T, ID> {

    /**
     * 根据主键ID查询获取数据
     *
     * @param id 主键ID
     * @return 实体类对象
     */
    T getById(ID id);

    /**
     * 根据主键ID查询获取数据
     *
     * @param id 主键ID
     * @return Optional对象
     */
    Optional<T> getOptionalById(ID id);

    /**
     * 根据查询实例条件获取数据
     *
     * @param example 查询实例
     * @return 实体类对象
     */
    T get(Example<T> example);

    /**
     * 根据查询实例条件获取数据
     *
     * @param example 查询实例
     * @return Optional对象
     */
    Optional<T> getOptional(Example<T> example);

    /**
     * 获取全部数据
     *
     * @return 列表数据
     */
    List<T> lists();

    /**
     * 获取全部数据，并且进行排序
     *
     * @param sort 排序对象
     * @return 列表数据
     */
    List<T> lists(Sort sort);

    /**
     * 根据查询实例条件获取数据
     *
     * @param example 查询实例
     * @return 列表数据
     */
    List<T> lists(Example<T> example);

    /**
     * 根据查询实例条件获取数据，并且进行排序
     *
     * @param example 查询实例
     * @param sort    排序对象
     * @return 列表数据
     */
    List<T> lists(Example<T> example, Sort sort);

    /**
     * 根据主键ID列表获取对应的数据
     *
     * @param ids 主键ID列表
     * @return 列表数据
     */
    List<T> listById(Iterable<ID> ids);

    /**
     * 根据查询实例条件获取数据，并且进行分页
     *
     * @param pageable 分页配置对象
     * @return 分页数据
     */
    Page<T> pages(Pageable pageable);

    /**
     * 根据查询实例条件获取数据，并且进行分页
     *
     * @param example  查询实例
     * @param pageable 分页配置对象
     * @return 分页数据
     */
    Page<T> pages(Example<T> example, Pageable pageable);

    /**
     * 统计个数
     *
     * @return 数量
     */
    long count();

    /**
     * 根据查询实例条件统计个数
     *
     * @param example 查询实例
     * @return 数量
     */
    long count(Example<T> example);

    /**
     * 根据查询实例条件判断数据是否存在
     *
     * @param example 查询实例
     * @return Boolean
     */
    boolean exists(Example<T> example);

    /**
     * 根据主键ID判断数据是否存在
     *
     * @param id 主键ID
     * @return Boolean
     */
    boolean existsById(ID id);

    /**
     * 保存数据
     *
     * @param entity 实体类对象
     * @return 保存后的数据
     */
    T save(T entity);

    /**
     * 保存列表数据
     *
     * @param entities 列表数据
     * @return 保存后的数据
     */
    List<T> saveAll(Iterable<T> entities);

    /**
     * 立即保存数据
     *
     * @param entity 实体类对象
     * @return 保存后的数据
     */
    T saveAndFlush(T entity);

    /**
     * 立即保存列表数据
     *
     * @param entities 实体类列表
     * @return 保存后的数据
     */
    List<T> saveAllAndFlush(Iterable<T> entities);

    /**
     * 根据主键ID删除数据
     *
     * @param id 主键ID
     */
    void deleteById(ID id);

    /**
     * 删除对应实体类的数据
     *
     * @param entity 实体类对象
     */
    void delete(T entity);

    /**
     * 删除全部数据
     */
    void deleteAll();

    /**
     * 删除对应实体类列表的数据
     *
     * @param entities 数据列表
     */
    void deleteAll(Iterable<? extends T> entities);

    /**
     * 删除对应主键ID列表的数据
     *
     * @param ids 主键ID列表
     */
    void deleteAllById(Iterable<? extends ID> ids);

    /**
     * 批量删除对应主键ID列表的数据
     *
     * @param ids 主键ID列表
     */
    void deleteAllByIdInBatch(Iterable<ID> ids);

    /**
     * 批量删除对应实体类列表的数据
     *
     * @param entities 数据列表
     */
    void deleteAllInBatch(Iterable<T> entities);

    /**
     * 批量删除全部数据
     */
    void deleteAllInBatch();
}
